home *** CD-ROM | disk | FTP | other *** search
/ Australian Personal Computer 1998 July / apc37.iso / netkit / mac / dcomet / dcomet.hqx / Documents / 1.1 VT100 Command Set < prev    next >
Encoding:
Text File  |  1998-01-29  |  15.3 KB  |  429 lines
  1.  
  2.  
  3.                          1.1 VT100 Command Set
  4.  
  5. _____________________________________________________________________________
  6.  
  7.       dataComet documentation.  (Rev. 11/19/97) 
  8.       Copyright 1995 databeast, Inc. All Rights Reserved.
  9.  
  10.       ___________________________________________________
  11.  
  12.  
  13.    This document has information on (select and use "Find..." to go to the section):
  14.  
  15.          Modes
  16.          Programmable UDKs (User Defined Keys)
  17.          Cursor Movement Commands
  18.          Screen Editing (Insert/Delete)
  19.          Line Size Commands (Double-Height and Double-Width) 
  20.          Character Attributes
  21.          Scrolling Region
  22.          Tab stops
  23.          Printing
  24.          Character Set (G0 and G1 Designators)
  25.          Cursor Position Report
  26.          Status Report
  27.          Identify
  28.          Reset
  29.          Confidence Tests
  30.          VT52 Compatible Mode
  31.          Programmable LEDs (Not supported)
  32.  
  33.  
  34.    _______________________________________________________________________
  35.  
  36.          ANSI Compatible Mode
  37.    _______________________________________________________________________
  38.  
  39.       Note that the '!C>command\000' macro allows you to set any of 
  40.       the modes listed below in a key macro.
  41.  
  42.       "\nnn" -> a decimal number representing a character, e.g.,
  43.       "\027" -> <ESCAPE>.  This encoding allows you to use the
  44.       strings listed below directly in dataComet macros.
  45.  
  46.       Unless otherwise noted, all command sequences listed are supported
  47.       by dataComet.
  48.  
  49.    _______________________________________________________________________
  50.  
  51.          Modes
  52.    _______________________________________________________________________
  53.  
  54.                                   To Set                   To Reset
  55.       Mode Name             Mode        Sequence      Mode        Sequence
  56.  
  57.       Keypad mode           Application  \027=        Numeric     \027>
  58.       Cursor key mode       Application  \027[?1h     Cursor      \027[?l
  59.       Keyboard action       Locked       \027[2h      Unlocked    \027[2l
  60.       Column mode           132 Col      \027[?3h     80 Col      \027[?3l
  61.       Scrolling mode        Smooth       \027[?4h     Jump        \027[?4l
  62.       Insert mode           Insert       \027[4h      Overwrite   \027[4l
  63.       Screen mode           Reverse      \027[?5h     Normal      \027[?5l
  64.       Origin mode           Relative     \027[?6h     Absolute    \027[?6l
  65.       Autowrap              On           \027[?7h     Off         \027[?7l
  66.       Auto repeat           On           \027[?8h     Off         \027[?8l
  67.       Print form feed       Add FF       \027[?18h    No FF added \027[?18l
  68.       Print extent          Whole page   \027[?19h    Scroll rgn. \027[?19l
  69.       Line feed/new line    New line     \027[20h     Line feed   \027[20l
  70.       Nat'l character set   ASCII        \027[?42h    Local Nat'l \027[?42l (1)
  71.       Backarrow key         Backspace    \027[?67h    Delete      \027[?67l
  72.       ANSI/VT52 mode        ANSI         \027<        VT52        \027[?2l
  73.  
  74.  
  75.    _______________________________________________________________________
  76.  
  77.          Programmable UDKs (User Defined Keys)
  78.    _______________________________________________________________________
  79.  
  80.       \027[Pc;Pl|Key1/Str1;...,KeyN/StrN\156
  81.  
  82.       \027[Pc;Pl;Pt;Pm|Key1/Name1?Str1;...,KeyN/NameN?StrN\156  
  83.              (dataComet Button Bar UDK, optional)
  84.  
  85.       Pc is the clear parameter
  86.  
  87.          0   Clear all keys
  88.          1   Clear only keys with new settings
  89.  
  90.       Pl is the lock parameter
  91.  
  92.          0   FKeys and Button Bar
  93.          1   FKeys only
  94.          2   Button Bar only
  95.  
  96.          dataComet always Locks the FKeys and Buttons; this
  97.          parameter is used to specify which items are affected.
  98.  
  99.       Pt is the type parameter (dataComet Button UDK, optional)
  100.  
  101.          0   "Classic" mapping (default if not specified)
  102.          1   dataComet mapping
  103.  
  104.       Pm is the macro parameter (dataComet Button UDK, optional)
  105.  
  106.          0   StrN is plain text (default if not specified)
  107.          1   StrN should be interpreted as a dataComet macro
  108.  
  109.      "KeyN" is a string indicating which PFkey/Button is to be remapped.
  110.  
  111.      "StrN" is a string parameter with the string to send when the PFkey 
  112.          or button is pressed.
  113.  
  114.       The command must always be terminated with the String Terminator 
  115.       sequence, either the ST character (\156) or "\027\" (ESC-\).
  116.  
  117.  
  118.       ____________________________________________________
  119.  
  120.                    dataComet mapping
  121.              ________________________________
  122.  
  123.       "KeyN" "1" = F1, "2" = F2, etc.; 
  124.           KeyN from "1" - "24" apply to the controls in the Button Bar.  
  125.           KeyN from from "101" - "164" apply to the labels and buttons 
  126.                on the left hand side of the emulator screen ("101" = 1).
  127.  
  128.       "NameN" is a string parameter with the button name, terminated by a 
  129.           '?'.  This parameter is required to set a host-defined button in 
  130.           the button bar which is displayed at the top of the dataComet 
  131.           emulator window.
  132.  
  133.        dataComet mapping uses plain ASCII for the string parameters,
  134.           so the button name and macro are easier to create and maintain.
  135.                
  136.        Here's an example which works with UNIX, setting F1 (and the first
  137.        button) to execute a macro with a delay, and F2 to send "ls -lt":
  138.  
  139. cat << 'EOT'
  140. ;1;1|1/Wham?echo !D\003WHAMMO\010;2/lt?ls -lt\010£
  141. 'EOT'
  142.  
  143.       ____________________________________________________
  144.  
  145.  
  146.              ________________________________
  147.  
  148.                    "Classic" mapping
  149.  
  150.                KeyN is one of the following
  151.              ________________________________
  152.  
  153.                       F1        1
  154.                       F2        2
  155.                         etc.  ...
  156.                       F16      16   (dataComet extension)
  157.  
  158.                       F6       17   (Standard)      
  159.                       F7       18
  160.                       F8       19
  161.                       F9       20
  162.                       F10      21
  163.                       F11      23
  164.                       F12      24
  165.                       F13      25
  166.                       F14      26
  167.                       F15      28
  168.                       F16      29
  169.                       F17      31
  170.                       F18      32
  171.                       F19      33
  172.                       F20      34
  173.              ________________________________
  174.  
  175.               StrN is a "Classic" UDK string,
  176.                   encoded in hexadecimal 
  177.                     (i.e., 'N' = 4E)
  178.              ________________________________
  179.  
  180.  
  181.    _______________________________________________________________________
  182.  
  183.          Cursor Movement Commands
  184.    _______________________________________________________________________
  185.  
  186.       Cursor up                            \027[PnA
  187.       Cursor down                          \027[PnB
  188.       Cursor forward (right)               \027[PnC
  189.       Cursor backward (left)               \027[PnD
  190.       Direct cursor addressing             \027[Pl;PcH   or
  191.                                            \027[Pl;Pcf
  192.       Index                                \027D
  193.       Next Line                            \027E
  194.       Reverse index                        \027M
  195.       Save cursor and attributes           \0277
  196.       Restore cursor and attributes        \0278
  197.  
  198.       * Pn = decimal parameter in string of ASCII digits.(default 1)
  199.       * Pl = line number (default 0); Pc = column number (default 0)
  200.  
  201.    _______________________________________________________________________
  202.  
  203.          Screen Editing (Insert/Delete)
  204.    _______________________________________________________________________
  205.  
  206.       From cursor to end of screen         \027[J  or \027[0J
  207.       From beginning of screen to cursor   \027[1J
  208.       Entire screen                        \027[2J
  209.       From cursor to end of line           \027[K  or \027[0K
  210.       From beginning of line to cursor     \027[1K
  211.       Entire line containing cursor        \027[2K
  212.       Entire line containing cursor        \027[2K
  213.       Insert line                          \027[PnL
  214.       Delete line                          \027[PnM
  215.       Delete characters                    \027[PnP
  216.       Insert characters                    \027[Pn@
  217.       
  218.    _______________________________________________________________________
  219.  
  220.          Line Size Commands (Double-Height and Double-Width) 
  221.    _______________________________________________________________________
  222.  
  223.       Change this line to double-height top half       \027#3
  224.       Change this line to double-height bottom half    \027#4
  225.       Change this line to single-width single-height   \027#5
  226.       Change this line to double-width single-height   \027#6
  227.  
  228.    _______________________________________________________________________
  229.  
  230.          Character Attributes
  231.    _______________________________________________________________________
  232.  
  233.       \027[Ps;Ps;Ps;...,Psm
  234.  
  235.       Ps =   0 or None   All Attributes Off
  236.                   1      Bold on
  237.                   4      Underscore on
  238.                   5      Blink on
  239.                   7      Reverse video on
  240.                   8      Invisible on
  241.                  22      Bold off
  242.                  24      Underscore off
  243.                  25      Blink off
  244.                  27      Reverse off
  245.                  28      Invisible off
  246.   
  247.                 Colors:   Foreground  Background
  248.  
  249.                 Black         30          40
  250.                 Red           31          41
  251.                 Green         32          42
  252.                 Yellow        33          43
  253.                 Blue          34          44
  254.                 Magenta       35          45
  255.                 Cyan          36          46
  256.                 White         37          47
  257.  
  258.          Any other parameter values are ignored.
  259.  
  260.  
  261.    _______________________________________________________________________
  262.  
  263.          Scrolling Region
  264.    _______________________________________________________________________
  265.  
  266.       \027[Pt;Pbr
  267.  
  268.       Pt is the number of the top line of the scrolling region;
  269.       Pb is the number of the bottom line of the scrolling region 
  270.          and must be greater than Pt.
  271.       (The default for Pt is line 1, the default for Pb is the end 
  272.          of the screen)
  273.  
  274.    _______________________________________________________________________
  275.  
  276.          Tab stops
  277.    _______________________________________________________________________
  278.  
  279.       Set tab at current column      \027H
  280.       Clear tab at curent column     \027[g   or   \027[0g
  281.       Clear all tabs                 \027[3g
  282.  
  283.    _______________________________________________________________________
  284.  
  285.          Printing
  286.    _______________________________________________________________________
  287.  
  288.        Print screen                  \027[i   or   \027[0i
  289.        Print without display on      \027[5i 
  290.        Print without display off     \027[4i 
  291.          
  292.        Auto print on                 \027[?5i
  293.           (lines print as cursor moves off line w/ LF, VT, or FF)
  294.  
  295.        Auto print off               \027[?4i
  296.        Print cursor's display line  \027[?1i
  297.       
  298.    _______________________________________________________________________
  299.  
  300.          Character Set (G0 and G1 Designators)
  301.    _______________________________________________________________________
  302.  
  303.       Character Set               G0 Designator   G1 Designator
  304.  
  305.       United Kingdom (UK)            \027(A      \027)A
  306.       United States (USASCII)        \027(B      \027)B
  307.       Graphics characters            \027(0      \027)0
  308.          and line drawing set
  309.       Alternate character ROM        \027(1      \027)1
  310.       Alternate character ROM        \027(2      \027)2
  311.          graphics characters
  312.  
  313.       Lock Shift G0                  \015
  314.       Lock Shift G1                  \014
  315.       Lock Shift G1 Right            \027~
  316.       Lock Shift G2                  \027n
  317.       Lock Shift G2 Right            \027}
  318.       Lock Shift G3                  \027o
  319.       Lock Shift G3 Right            \027|
  320.       Single Shift G2                \027N
  321.       Single Shift G3                \027O
  322.  
  323.  
  324.    _______________________________________________________________________
  325.  
  326.          Cursor Position Report
  327.    _______________________________________________________________________
  328.  
  329.          Invoked by                  \027[6n
  330.          Response is                 \027[Pl;PcR
  331.  
  332.           * Pl = line number; Pc = column number
  333.  
  334.    _______________________________________________________________________
  335.  
  336.          Status Report
  337.    _______________________________________________________________________
  338.  
  339.          Invoked by                  \027[5n
  340.          Response is                 \027[0n  (terminal ok)
  341.                                      \027[3n  (terminal not ok)
  342.  
  343.    _______________________________________________________________________
  344.  
  345.          Identify
  346.    _______________________________________________________________________
  347.  
  348.          Invoked by                  \027[c  or  \027[Oc
  349.          Response is                 \027[?1;PsC
  350.  
  351.       Ps =   0   Base VT100, no options
  352.              1   Processor option (STP)
  353.              2   Advanced Video option (AVO)
  354.              3   AVO and STP
  355.              4   Graphics processor option (GO)
  356.              5   GO and STP
  357.              6   GO and AVO
  358.              7   GO, STP, and AVO
  359.  
  360.          Alternately invoked by \027Z (not recommended.)
  361.  
  362.    _______________________________________________________________________
  363.  
  364.          Reset
  365.    _______________________________________________________________________
  366.  
  367.       \027c
  368.  
  369.    _______________________________________________________________________
  370.  
  371.          Confidence Tests
  372.    _______________________________________________________________________
  373.  
  374.       Fill Screen with "E"s         \027#8
  375.       Invoke Test(s)                \027[2;Psy
  376.          Ps =   1                   Power-up self test
  377.          8                          Repeat selected test(s)
  378.                                     indefinitely (until failure or power off)
  379.  
  380.    _______________________________________________________________________
  381.  
  382.  
  383.          VT52 Compatible Mode
  384.  
  385.       _____________________________________
  386.  
  387.  
  388.       Cursor Up                       \027A
  389.       Cursor Down                     \027B
  390.       Cursor Right                    \027C
  391.       Cursor Left                     \027D
  392.       Select Graphics character set   \027F        (selects Bold in dataComet)
  393.       Select ASCII character set      \027G
  394.       Cursor to home                  \027H
  395.       Reverse line feed               \027I
  396.       Erase to end of screen          \027J
  397.       Erase to end of line            \027K
  398.       Direct cursor address           \027Ylc      (see note 1)
  399.       Identify                        \027Z        (see note 2)
  400.       Enter alternate keypad mode     \027=
  401.       Exit alternate keypad mode      \027>
  402.       Enter ANSI mode                 \027<
  403.  
  404.       NOTE 1: Line and column numbers for direct cursor address are single
  405.          character codes whose values are the desired number plus
  406.          37 (in Octal). Line and column numbers start at 1.
  407.  
  408.       NOTE 2: Response to \027Z is \027/ Z.
  409.  
  410.  
  411.    _______________________________________________________________________
  412.  
  413.          Programmable LEDs (Not supported)
  414.    _______________________________________________________________________
  415.  
  416.       \027[Ps;Ps;...Psq
  417.  
  418.       Ps =   0 or None   All LEDs Off
  419.                   1      L1 on
  420.                   2      L2 on
  421.                   3      L3 on
  422.                   4      L4 on
  423.  
  424.       Any other parameter values are ignored.
  425.  
  426.  
  427. _____________________________________________________________________________
  428.  
  429.